<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Permission</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface Permission</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The permissions used by <a href="../phpContentRepository/AccessManager.html">AccessManager</a>.</p>
<p class="description"><p>Level 2 only</p><p>Given a particular <a href="../phpContentRepository/Ticket.html">Ticket</a>, a particular <a href="../phpContentRepository/Permission.html">Permission</a> is  either TRUE or FALSE of a particular <a href="../phpContentRepository/Node.html">Node</a>  or <a href="../phpContentRepository/Property.html">Property</a>.</p><p>This interface defines the following permissions:  <ul><li><a href="../phpContentRepository/Permission.html#constADD_NODE">Permission::ADD_NODE</a></li><li><a href="../phpContentRepository/Permission.html#constSET_PROPERTY">Permission::SET_PROPERTY</a></li><li><a href="../phpContentRepository/Permission.html#constREMOVE_ITEM">Permission::REMOVE_ITEM</a></li><li><a href="../phpContentRepository/Permission.html#constREAD_ITEM">Permission::READ_ITEM</a></li></ul></p><p>Each constant is a power of 2 and thus can be set as a bitmask in an  integer value.</p></p>
	<ul class="tags">
				<li><span class="field">copyright:</span> Copyright &amp;copy; 2004-2005, Domain51</li>
				<li><span class="field">author:</span> PHP - Travis Swicegood &lt;<a href="mailto:travis@domain51.net">travis@domain51.net</a>&gt;</li>
				<li><span class="field">see:</span> <a href="../phpContentRepository/Workspace.html#methodgetAccessManager">Workspace::getAccessManager()</a>, <a href="../phpContentRepository/AccessManager.html">AccessManager</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_access_Permission_interface_php.html">/access/Permission.interface.php</a> (line <span class="field">50</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#ADD_NODE" title="details" class="const-name">ADD_NODE</a> = 					<span class="var-type"> 1</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#READ_ITEM" title="details" class="const-name">READ_ITEM</a> = 					<span class="var-type"> 8</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#REMOVE_ITEM" title="details" class="const-name">REMOVE_ITEM</a> = 					<span class="var-type"> 4</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#SET_PROPERTY" title="details" class="const-name">SET_PROPERTY</a> = 					<span class="var-type"> 2</span>

				</div>
							</div>
		</div>
	</div>


	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
									<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getName" title="details" class="method-name">getName</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getValue" title="details" class="method-name">getValue</a>
										()
									</div>
							</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodgetName" id="getName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getName</span> (line <span class="line-number">167</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the descriptive name of this permission.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The name</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">see:</span> <a href="../phpContentRepository/AccessManager.html#methodgetSupportedPermissions">AccessManager::getSupportedPermissions()</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getName
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetValue" id="getValue"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getValue</span> (line <span class="line-number">157</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the numerical constant identifying this <a href="../phpContentRepository/Permission.html">Permission</a>.</p>
<p class="description"><p>This value is always a power of 2 ((i.e. sets of permissions can be  encoded as a bitmask in a integer value).</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> The numerical value</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">see:</span> <a href="../phpContentRepository/AccessManager.html#methodgetSupportedPermissions">AccessManager::getSupportedPermissions()</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getValue
		</span>
				()
			</div>
	
		
		
	</div>
						
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="constADD_NODE" id="ADD_NODE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">ADD_NODE</span>
			 = <span class="const-default"> 1</span>
			(line <span class="line-number">71</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether adding a <a href="../phpContentRepository/Node.html">Node</a> is allowed.</p>
<p class="description"><p>If this value is present in either <a href="../phpContentRepository/AccessManager.html#methodisGranted">AccessManager::isGranted()</a> or  <a href="../phpContentRepository/AccessManager.html#methodgetPermissions">AccessManager::getPermissions()</a>, then a given node's  <a href="../phpContentRepository/Node.html#methodaddNode">Node::addNode()</a> is allowed.</p><p><a href="../phpContentRepository/AccessManager.html#methodisGranted">AccessManager::isGranted()</a> looking for this value on a  <a href="../phpContentRepository/Property.html">Property</a> should always return FALSE.</p><p>If not present, <a href="../phpContentRepository/Exceptions/AccessDeniedException.html">AccessDeniedException</a> should be thrown on  <a href="../phpContentRepository/Node.html#methodsave">Node::save()</a>.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../phpContentRepository/AccessManager.html#methodisGranted">AccessManager::isGranted()</a>, <a href="../phpContentRepository/AccessManager.html#methodgetPermissions">AccessManager::getPermissions()</a>, <a href="../phpContentRepository/Node.html#methodaddNode">Node::addNode()</a></li>
			</ul>
	
	
</div>
<a name="constREAD_ITEM" id="READ_ITEM"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">READ_ITEM</span>
			 = <span class="const-default"> 8</span>
			(line <span class="line-number">144</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines if an a given <a href="../phpContentRepository/Item.html">Item</a> can be read.</p>
<p class="description"><p>If this value is present in either <a href="../phpContentRepository/AccessManager.html#methodisGranted">AccessManager::isGranted()</a> or  <a href="../phpContentRepository/AccessManager.html#methodgetPermissions">AccessManager::getPermissions()</a> for a <a href="../phpContentRepository/Property.html">Property</a>, reading  it via <a href="../phpContentRepository/Node.html#methodgetProperty">Node::getProperty()</a> is permitted.  Note: This  <a href="../phpContentRepository/Property.html">Property</a> must be relative to the the given <a href="../phpContentRepository/Node.html">Node</a> trying to  read it.</p><p>$m = '/example/node/property';    $n = '/example/node';    $mObj = $nObj-&gt;getProperty('property');</p><p>If this value is present in either <a href="../phpContentRepository/AccessManager.html#methodisGranted">AccessManager::isGranted()</a> or  <a href="../phpContentRepository/AccessManager.html#methodgetPermissions">AccessManager::getPermissions()</a> for a <a href="../phpContentRepository/Node.html">Node</a>, reading it  via <a href="../phpContentRepository/Node.html#methodgetNode">Node::getNode()</a> is permitted.  Note: This  <a href="../phpContentRepository/Node.html">Node</a> must be relative to the given <a href="../phpContentRepository/Node.html">Node</a> trying to read it.</p><p>$m = '/example/parent/node';    $n = '/example/parent';    $mObj = $nObj-&gt;getNode('node');</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../phpContentRepository/AccessManager.html#methodisGranted">AccessManager::isGranted()</a>, <a href="../phpContentRepository/AccessManager.html#methodgetPermissions">AccessManager::getPermissions()</a>, <a href="../phpContentRepository/Node.html#methodgetProperty">Node::getProperty()</a>, node::getNode()</li>
			</ul>
	
	
</div>
<a name="constREMOVE_ITEM" id="REMOVE_ITEM"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">REMOVE_ITEM</span>
			 = <span class="const-default"> 4</span>
			(line <span class="line-number">111</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether removal of this <a href="../phpContentRepository/Item.html">Item</a> is allowed.</p>
<p class="description"><p>If this value is present in either <a href="../phpContentRepository/AccessManager.html#methodisGranted">AccessManager::isGranted()</a> or  <a href="../phpContentRepository/AccessManager.html#methodgetPermissions">AccessManager::getPermissions()</a> for an <a href="../phpContentRepository/Item.html">Item</a>, then that  item's <a href="../phpContentRepository/Node.html#methodremove">Node::remove()</a> is allowed.</p><p>This must be set on the parent <a href="../phpContentRepository/Node.html">Node</a> in order to remove a  <a href="../phpContentRepository/Node.html">Node</a>.  See <a href="../phpContentRepository/Node.html#methodremove">Node::remove()</a> for a full explanation of how  removal should work.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../phpContentRepository/AccessManager.html#methodisGranted">AccessManager::isGranted()</a>, <a href="../phpContentRepository/AccessManager.html#methodgetPermissions">AccessManager::getPermissions()</a>, <a href="../phpContentRepository/Node.html#methodremove">Node::remove()</a></li>
			</ul>
	
	
</div>
<a name="constSET_PROPERTY" id="SET_PROPERTY"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">SET_PROPERTY</span>
			 = <span class="const-default"> 2</span>
			(line <span class="line-number">93</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether setting a <a href="../phpContentRepository/Property.html">Property</a> for a <a href="../phpContentRepository/Node.html">Node</a> via  <a href="../phpContentRepository/Node.html#methodsetProperty">Node::setProperty()</a> is allowed.</p>
<p class="description"><p>If this value is present in either <a href="../phpContentRepository/AccessManager.html#methodisGranted">AccessManager::isGranted()</a> or  <a href="../phpContentRepository/AccessManager.html#methodgetPermissions">AccessManager::getPermissions()</a> for a <a href="../phpContentRepository/Node.html">Node</a>, then that  node's <a href="../phpContentRepository/Node.html#methodsetProperty">Node::setProperty()</a> is allowed.</p><p>If this value is present in either <a href="../phpContentRepository/AccessManager.html#methodisGranted">AccessManager::isGranted()</a> or  <a href="../phpContentRepository/AccessManager.html#methodgetPermissions">AccessManager::getPermissions()</a> for a <a href="../phpContentRepository/Property.html">Property</a>, then that  property's <a href="../phpContentRepository/Property.html#methodsetValue">Property::setValue()</a> is allowed.</p><p>If not present, <a href="../phpContentRepository/Exceptions/AccessDeniedException.html">AccessDeniedException</a> should be thrown on  <a href="../phpContentRepository/Node.html#methodsave">Node::save()</a>.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../phpContentRepository/AccessManager.html#methodisGranted">AccessManager::isGranted()</a>, <a href="../phpContentRepository/AccessManager.html#methodgetPermissions">AccessManager::getPermissions()</a>, <a href="../phpContentRepository/Node.html#methodsetProperty">Node::setProperty()</a>, <a href="../phpContentRepository/Property.html#methodsetValue">Property::setValue()</a></li>
			</ul>
	
	
</div>
						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Fri, 31 Dec 2004 10:15:19 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>